Process/Definitions({FullName})/StartInstance

Starts a new process instance for the specified process definition full name.

URI

{Service Root URI}/Process/Definitions({FullName})/StartInstance?{Query Options}
https://api.denallix.com:443/K2Services/REST.svc/Process/Definitions(K2%20Examples_B_Order%20Process)/StartInstance?folio=Order-K2

Method

GET

Service Path Options

Required

• FullName (String) – the full name of the process definition.  Requires the use of Replacement Characters.

Query Options

Optional

• Custom Query Options
o Folio (String) – the folio value to assign to the process instance.  Uses current DateTime as default if no value is provided.

Return Type

Process Instance Id (Long) or Failure

GET /K2Services/REST.svc/Process/Definitions(K2%20Examples_B_Order%20Process)/StartInstance?folio=Order-K2
			<?xml version="1.0" encoding="utf-8"?>                    <long>3</long>